dxp-ux
customerBill(TMF678 GET) retriveCustomerBills - V2
CASE 1 Unitary Test
This use case is to retrieve bill history from evertec
URL
https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/customerBillURI Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| billingAccount.id | string | customer account id | Y |
| relatedParty.id | string | describes the billing provider as a related party playing the role of organization example 002 for AT&T and 001 for Liberty | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/customerBill?billingAccount.id=821470133&relatedParty.id=002' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'X-Correlation-ID: 26565-56255-4245625'Response
200 OK
[
{
"billDate": "2024-07-18", //cycleDate
"billDocument": [
{
"id": "S2NrUi9zeG9ySFZkUXZIdW9FMjJsQT09", //objectId
"attachmentType": "text",
"content": "900", //pageCount
"size": {
"amount": 28135, //fileSize value
"units": "KB" //fileSize units
}
}
],
"billingAccount": {
"id": "287309684133" //billingAccount.id
},
"relatedParty": [
{
"id": "true", //true
"name": "viewed", //viewed
"role": "CustomerAction"
},
{
"id": "2", //productId 1 or 2
"name": "AT&T", //AT&T or Liberate
"role": "BillProvider"
}
]
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| billDate | datetime | Bill date | N |
| billDocument | array | Array object of bill document | N |
| billDocument.id | string | bill document object unique identifier | N |
| billDocument.content | string | length of document | N |
| billDocument.size | object | object to descript the size of document | N |
| billDocument.size.units | string | units of the size | N |
| billDocument.size.amount | string | amount of the size | N |
| billDocument.attachmentType | string | attachment type of bill document | N |
| billingAccount | object | billing account object | N |
| billingAccount.id | string | unique identifier of billingAccount | N |
| relatedParty | Array | related party array | N |
| relatedParty.id | string | value of the related party Example: Product id, expected values are 1 or 2 | N |
| relatedParty.name | string | name of the related party Example: Type of account, expected values are AT&T or Liberate | N |
| relatedParty.role | string | role of the related party id | N |